home *** CD-ROM | disk | FTP | other *** search
/ Software of the Month Club 1996 June / Software of the Month Club 1996 June.iso / pc / os2 / htmlgen / htmlgen.hlp (.txt) < prev    next >
OS/2 Help File  |  1995-08-04  |  16KB  |  485 lines
  1.  
  2. ΓòÉΓòÉΓòÉ 1. HTMLGen - An Overview ΓòÉΓòÉΓòÉ
  3.  
  4. HTMLGen is a HTML script generator for OS/2. 
  5.  
  6. HTML scripts are used to generate Home Pages for World Wide Web browsers. 
  7.  
  8. HTMLGen provides a simple method for generating scripts.  By selecting the 
  9. appropriate tag, a dialog box will pop-up to gather data and fill in the 
  10. script. 
  11.  
  12.  
  13. ΓòÉΓòÉΓòÉ 2. Adding To Desktop ΓòÉΓòÉΓòÉ
  14.  
  15. To place the program on your WPS Desktop use the following rexx script. 
  16.  
  17.   /* Place HTMLGen on Your Desktop */
  18.   rc = RxFuncAdd("SysLoadFuncs","RexxUtil","SysLoadFuncs")
  19.   rc = SysLoadFuncs()
  20.   rc = SysCreateObject("WPProgram","HTMLGen","","exename="||directory()||"\htmlgen.exe")
  21.   rc = SysSetIcon(directory()||"\htmlgen.exe","htmlgen.ico")
  22.  
  23.  
  24. ΓòÉΓòÉΓòÉ 3. Register ΓòÉΓòÉΓòÉ
  25.  
  26. REGISTRATION FORM FOR HTMLGen Version 1.10
  27.  
  28. Registration fee is $45.00 per copy.
  29.  
  30. North Carolina residents must include sales tax.
  31. In USA and Canada add $5.00 for shipping/handling.
  32. All other international shipments add $15.00.
  33.  
  34. See other documentation.
  35.  
  36. Send to: HTMLGen 1.10
  37.          American Coders, LTD
  38.          P.O. Box 97462
  39.          Raleigh, NC  27624
  40.  
  41. Name:______________________________________      Phone: ____________
  42. Company: ___________________________________     Phone: ____________
  43. Address: ___________________________________________________________
  44.          ___________________________________________________________
  45. City: _________________________    State: ______  Zip: _____________
  46.  
  47. CompuServe ID: _____________________________________________________
  48.  
  49. Where did you find HTMLGen: _______________________________________
  50.  
  51. Registered users get a 30 day money back guarantee, 60 days free telephone
  52. support, unlimited support on CompuServe, and free upgrades to the
  53. next release.
  54.  
  55. CompuServe ID:  74150,2370
  56. CompuServe Support: GO OS2SHARE
  57.  
  58. Internet: joe@usacoder.rtp.nc.us
  59.  
  60. Phone: (919) 846-2014.
  61.  
  62.  
  63. ΓòÉΓòÉΓòÉ 4. Cut and Paste ΓòÉΓòÉΓòÉ
  64.  
  65. OS/2 Cut and Paste fucntions to the OS/2 clip-board are availablle. 
  66.  
  67. Cut       Press CTRL-Delete. To place mark text into the clipboard and remove 
  68.           it from the script area. 
  69.  
  70. Copy      Press CTRL-Insert. To copy the marked area to the clip-board. 
  71.  
  72. Paste     Press Shift-Insert to copy clip-board text at the cursors position. 
  73.  
  74. Marking Text To Cut and Copy Press Shift and use the arrow keys to mark pieces 
  75.           of text in the script area. 
  76.  
  77.  
  78. ΓòÉΓòÉΓòÉ 5. Primary Window Menu ΓòÉΓòÉΓòÉ
  79.  
  80. There are several window menus to simplify your job. 
  81.  
  82.  
  83. ΓòÉΓòÉΓòÉ 5.1. File ΓòÉΓòÉΓòÉ
  84.  
  85. The file pull down provides access to OS/2 file system. 
  86.  
  87.  
  88. ΓòÉΓòÉΓòÉ 5.1.1. Open ΓòÉΓòÉΓòÉ
  89.  
  90. Open will load the script area with an existing.  Any text in the script area 
  91. will be lost. 
  92.  
  93.  
  94. ΓòÉΓòÉΓòÉ 5.1.2. New ΓòÉΓòÉΓòÉ
  95.  
  96. This will restart a script by removing existing text. 
  97.  
  98.  
  99. ΓòÉΓòÉΓòÉ 5.1.3. Save ΓòÉΓòÉΓòÉ
  100.  
  101. This will save the script area to a file.  If a filename has not been defined 
  102. the File dialog will pop-up. 
  103.  
  104.  
  105. ΓòÉΓòÉΓòÉ 5.1.4. Save As ΓòÉΓòÉΓòÉ
  106.  
  107. This will save the script area to a file. The File dialog will pop-up. 
  108.  
  109.  
  110. ΓòÉΓòÉΓòÉ 5.1.5. Insert Text ΓòÉΓòÉΓòÉ
  111.  
  112. This will insert text from another file into the script area. Text in the 
  113. existing area will not be lost. 
  114.  
  115.  
  116. ΓòÉΓòÉΓòÉ 5.1.6. Browser ΓòÉΓòÉΓòÉ
  117.  
  118. This will load the current text area to the defined file and call the Web 
  119. Browser you have defined on your system. 
  120.  
  121.  
  122. ΓòÉΓòÉΓòÉ 5.1.7. IPF Build ΓòÉΓòÉΓòÉ
  123.  
  124. This will translate your HTML script into the IPF format. IPF is used by the 
  125. IBM IPFC compiler to generate INF and HLP files. 
  126.  
  127. IPFC compiler is not provide with HTLMGen. 
  128.  
  129.  
  130. ΓòÉΓòÉΓòÉ 5.1.8. Editor ΓòÉΓòÉΓòÉ
  131.  
  132. This will load the current text area to the defined file and call an editor you 
  133. have defined. 
  134.  
  135.  
  136. ΓòÉΓòÉΓòÉ 5.1.9. Exit ΓòÉΓòÉΓòÉ
  137.  
  138. This will exit the program.  Short-cut key is F3. 
  139.  
  140.  
  141. ΓòÉΓòÉΓòÉ 5.2. Options ΓòÉΓòÉΓòÉ
  142.  
  143. There are three options to provide HTMLGen with Browser/Editor and Text 
  144. prompting indicators. 
  145.  
  146.  
  147. ΓòÉΓòÉΓòÉ 5.2.1. Browser Defined ΓòÉΓòÉΓòÉ
  148.  
  149. Will pop-up a dialog box asking for the command to load your Web browser. 
  150.  
  151.  
  152. ΓòÉΓòÉΓòÉ 5.2.2. Editor Defined ΓòÉΓòÉΓòÉ
  153.  
  154. Will pop-up a dialog box asking for the command to load your editor. 
  155.  
  156.  
  157. ΓòÉΓòÉΓòÉ 5.2.3. Text Prompting ΓòÉΓòÉΓòÉ
  158.  
  159. This will turn-on/off the dialog boxes when the Tagging functions are used. 
  160.  
  161.  
  162. ΓòÉΓòÉΓòÉ 5.2.4. IPF Conversion Options ΓòÉΓòÉΓòÉ
  163.  
  164. There are three options available for the IPFC Conversion. 
  165.  
  166. RES for Headings Turn this on and a resource number will be assigned to each 
  167. heading. This is useful for creating HLP files.  HLP files work with PM Help 
  168. functions.  Resources are associated with PM items such when F1 is pressed when 
  169. the cursor is on a button, defining the HELP push button, etc... 
  170.  
  171. Index for Headings Turn this on and each heading will have a IPF index assigned 
  172. to it. For the Heading 1, only an I1 tag is created.  For all other headings an 
  173. I1 tag is created and an I2 tag with a reference to the previous I1 tag. 
  174. Indexes define what shows up in the INDEX for your both HLP and INF files. 
  175.  
  176.  
  177. ΓòÉΓòÉΓòÉ 5.2.5. Edit Macros ΓòÉΓòÉΓòÉ
  178.  
  179. This provides a dialog box to maintain your macros.  Prompts are shown in the 
  180. macro list and text is entered into the macro list when the prompt is 
  181. double-clicked. 
  182.  
  183. Macros are maintained an editible file HTMLGEN.MAC. The format is rather 
  184. simple.  A keyword "PROMPT:" is used to indicate a new macro. Text on the same 
  185. line as "PROMPT:" is used for the macro prompt. All text following the prompt 
  186. is considered to be macro "text" that is inserted into the HTML document when 
  187. the prompt is double-clicked. 
  188.  
  189.  
  190. ΓòÉΓòÉΓòÉ 5.3. Tags ΓòÉΓòÉΓòÉ
  191.  
  192. Tags are the indentifies for the browser on how to display and format text, 
  193. pull in external files, and layout the general document. 
  194.  
  195.  
  196. ΓòÉΓòÉΓòÉ 5.3.1. Headings ΓòÉΓòÉΓòÉ
  197.  
  198. Title  <Title> </Title> The Title Tag describes the title of the HTML Document 
  199.  
  200. Heading 1 <H1> </H1> The Heading 1 Tag marks the highest level sections in the 
  201.           document. Its text and font are the same size as the TITLES.  Think 
  202.           of Heading 1 Tags as chapter indicators. 
  203.  
  204.           Short-Cut Key is Ctrl-1. 
  205.  
  206. Heading 2 <H2> </H2> The Heading 2 Tag marks the second highest level sections 
  207.           within a Heading 1 section. Its text and font are smaller than a 
  208.           Heading 1.
  209.  
  210.           Short-Cut Key is Ctrl-2. 
  211.  
  212. Heading 3 <H3> </H3> The Heading 3 Tag marks the third highest level sections 
  213.           in a document and follows a Heading 2 section. Its text and font are 
  214.           smaller than a Heading 2.
  215.  
  216.           Short-Cut Key is Ctrl-2. 
  217.  
  218. Heading 4 <H4> </H4> The Heading 4 Tag marks the fourth highest level sections 
  219.           in a document and follows a Heading 3 section. Its text and font are 
  220.           smaller than a Heading 3.
  221.  
  222.           Short-Cut Key is Ctrl-3. 
  223.  
  224. Heading 5 <H5> </H5> The Heading 5 Tag marks the fifth highest sections and 
  225.           second lowest in a document and follows  a Heading 4 section. Its 
  226.           text and font are smaller than a Heading 4.
  227.  
  228.           Short-Cut Key is Ctrl-5. 
  229.  
  230. Heading 6 <H6> </H6> The Heading 6 Tag marks the lowest sections in a document 
  231.           and follows a Heading 5 section. Its text and font are smaller than a 
  232.           Heading 5.
  233.  
  234.           Short-Cut Key is Ctrl-6. 
  235.  
  236.  
  237. ΓòÉΓòÉΓòÉ 5.3.2. Lists ΓòÉΓòÉΓòÉ
  238.  
  239. Unordered Lists <UL> </UL> Unrdered lists provide the ability to set off lists 
  240.           of text that are prefixed by bullets, dashes and filled circles. 
  241.           Unorder lists may be contained within other list types and may 
  242.           contain other list types.
  243.  
  244.           Short-cut key is Alt-u. 
  245.  
  246. Ordered Lists <OL> </OL> Ordered lists provide the ability to set off lists of 
  247.           text that are prefixed by a sequence of numbers.  Ordered lists may 
  248.           be contained within other list types and may contain other list types.
  249.  
  250.           Short-cut key is Alt-o. 
  251.  
  252. List Item (Order/Unordered List) <LI> </LI> List Item Tag provides an item 
  253.           within an Unorder or Order list. List Items must appear within an 
  254.           <UL> </UL> or <OL> </OL> block.
  255.  
  256.           Short-cut key is CTRL-i. 
  257.  
  258. Descriptive Lists <DL> </DL> Provides a list that contains a title and a 
  259.           description items.
  260.  
  261.           Short-cut key is Alt-d. 
  262.  
  263. Descriptive Title and Description. Descriptive Titles and Descriptions are used 
  264.           to mark informative areas of text. Descriptive Title and Text appear 
  265.           in pairs with in a <DL> </DL> block.
  266.  
  267.           Short-cut key is Ctrl-d. 
  268.  
  269.    Descriptive Title <DT> </DT> This provides for title for the following 
  270.              descriptive text. 
  271.  
  272.    Descriptive Description <DD> </DD> This provides a description used with the 
  273.              Descriptive Title. It may contain paragraphs, other lists and 
  274.              other information. 
  275.  
  276.  
  277. ΓòÉΓòÉΓòÉ 5.3.3. Blocks ΓòÉΓòÉΓòÉ
  278.  
  279. Preformatted Text <PRE> </PRE> The preformatted tag marks text for fixed-width 
  280.           font with carriage returns, spaces and tabs kept in place.  This 
  281.           section may contain other tags.
  282.  
  283.           Short-cut key is Alt-p. 
  284.  
  285. Quoted Text <BLOCKQUOTE> </BLOCKQUOTE> The block quote tag marks text for 
  286.           fixed-width font with carriage returns, spaces and tabs kept in 
  287.           place.  This section may contain other tags.
  288.  
  289.           Short-cut key is Alt-q. 
  290.  
  291. Address <ADDRESS> </ADDRESS> The address tags is used to describe the author of 
  292.           the document.  It is usually the last item in the document.  This 
  293.           section may contain other tags.
  294.  
  295.           Short-cut key is Alt-a. 
  296.  
  297. Anchor Name <A> </A> The anchor name text provides to ability for other 
  298.           sections of the docuement to refer back to this section of text. 
  299.  
  300.           Short-cut key is Alt-n. 
  301.  
  302. Anchor Reference <A HREF=> </A> The anchor name text provides to ability to 
  303.           refer back to another section of text mark by an anchor name. 
  304.  
  305.           Short-cut key is Alt-r. 
  306.  
  307.  
  308. ΓòÉΓòÉΓòÉ 5.3.4. Formats ΓòÉΓòÉΓòÉ
  309.  
  310. Formats provide changing the fonts of text.
  311.  
  312. o ITALICS 
  313.  
  314.    - Italics <I> </I> - Short-cut key is Ctrl-i. 
  315.  
  316.    - Emphasised Italics <em> </em> - Short-cut key is Ctrl-e. 
  317.  
  318.    - Citation <cite> </cite> - Short-cut key is Ctrl-c. 
  319.  
  320.    - Variable <var> </var> - Short-cut key is Ctrl-i. 
  321.  
  322. o BOLDS 
  323.  
  324.    - Bold <b> </b> - Short-cut key is Ctrl-b. 
  325.  
  326.    - Strong bold <strong> </strong> - Short-cut key is Ctrl-s. 
  327.  
  328. o MONO-SPACED 
  329.  
  330.    - Typewriter <TT> </TT> - Short-cut key is Ctrl-t. 
  331.  
  332.    - Code <CODE> </CODE> - Short-cut key is Ctrl-C. 
  333.  
  334.    - Sample <SAMP> </SAMP> - Short-cut key is Ctrl-s.. 
  335.  
  336.    - Keyboard <KDB> </KBD> - Short-cut key is Ctrl-k. 
  337.  
  338. o Definition <DFN> </DFN> - Short-cut key is Ctrl-d. 
  339.  
  340.    May not work with some Mosiac browers. 
  341.  
  342.  
  343. ΓòÉΓòÉΓòÉ 5.3.5. Special Characters ΓòÉΓòÉΓòÉ
  344.  
  345. o 'Less Than' character '<' is <. 
  346.  
  347. o 'Greater Than' character '>' is >. 
  348.  
  349. o 'Ampersand' character '&' is &. 
  350.  
  351. o The paragraph marker indicates a new paragraph. <P> </P> - can be used to 
  352.   indicate an end of a paragraph block. Short-cut key is Ctrl+Enter. 
  353.  
  354.  
  355. ΓòÉΓòÉΓòÉ 5.3.6. Images ΓòÉΓòÉΓòÉ
  356.  
  357. Inline Images <IMG SRC=...> Provides inline GIF or x-systems XBM pictures to 
  358.           display within your the document. 
  359.  
  360.           Short-cut key is ALT-SHIFT-I. 
  361.  
  362. External Images <A HREF = ...>link anchor</A> Refers to GIF or XBM files that 
  363.           reside elsewhere. It also provides for referencing. See Anchors. 
  364.           Short-cut key is ALT-SHIFT-E. 
  365.  
  366.  
  367. ΓòÉΓòÉΓòÉ 6. Dialog Boxes ΓòÉΓòÉΓòÉ
  368.  
  369. There are several dialog boxes to assist you in generating your HTML script. 
  370. These boxes can be disabled by turning off the Text Prompting off of options. 
  371. When Text Prompting is turned off, you are not prompted for text and the tag is 
  372. immediately inserted into the script.
  373.  
  374.  The titles of the dialog boxes will change depending on the tag being 
  375. generated and what type of work it is doing. 
  376.  
  377.  
  378. ΓòÉΓòÉΓòÉ 6.1. Desc Dialog Box ΓòÉΓòÉΓòÉ
  379.  
  380. This box is used to define both the Descriptive Item Heading and Descriptive 
  381. Item Text.  This will generate the <DT> and </DD> tags.  If text is not entered 
  382. into either fields the tagged items are added to the script only, respectfully. 
  383.  
  384.  
  385. ΓòÉΓòÉΓòÉ 6.2. Ext Dialog Box ΓòÉΓòÉΓòÉ
  386.  
  387. This box is used to define an external file anchor.  The dialog will generate 
  388. the <A HREF=xxxxx#yyyyy>zzzzz</A> tag.  Where xxxxx is the name of the external 
  389. (referenced) file, yyyyy is the named anchor and zzzzz is the text that will be 
  390. highlighted and provide linking. 
  391.  
  392.  
  393. ΓòÉΓòÉΓòÉ 6.3. Extern Dialog Box ΓòÉΓòÉΓòÉ
  394.  
  395. This box is used to define an external image file and refernce text. The dialog 
  396. will generate the <A HREF=xxxxx>zzzzz</A> tag.  Where xxxxx is the name of the 
  397. external(image file and zzzzz is the text that will be highlighted and provide linking.
  398.  
  399.  The FIND button starts the PM Find File dialog to help you search for a file.
  400.  
  401.  Supported image files are 
  402.  
  403. o GIF 
  404.  
  405. o TIFF 
  406.  
  407. o JPEG 
  408.  
  409. o RGB 
  410.  
  411. o HDF 
  412.  
  413.  
  414. ΓòÉΓòÉΓòÉ 6.4. Inline Image Dialog Box ΓòÉΓòÉΓòÉ
  415.  
  416. This box provices the IMG tagto alloc for XBM and GIF format images inside your 
  417. HTML document.  This tag is not recognized by all browsers. 
  418.  
  419. The FIND button starts the PM Find File dialog to help you search for a file.
  420.  
  421.  
  422. ΓòÉΓòÉΓòÉ 6.5. Single Line Dialog Box ΓòÉΓòÉΓòÉ
  423.  
  424. This box is used for tags that use a single line of text, such as headers and 
  425. the address tags. 
  426.  
  427.  
  428. ΓòÉΓòÉΓòÉ 6.6. Anchor Dialog Box ΓòÉΓòÉΓòÉ
  429.  
  430. The box will allow you to define an anchor title and text. It generates an <A> 
  431. </A> tag. 
  432.  
  433.  
  434. ΓòÉΓòÉΓòÉ 6.7. Simple Text Dialog Box ΓòÉΓòÉΓòÉ
  435.  
  436. This box is used for tags that use multiple lines of text, such as tagging 
  437. formatted text or defining block quotes. The dialogs main item is a multi-line 
  438. edit field.  This field supports most of OS/2 cut and paste functions. 
  439.  
  440.  
  441. ΓòÉΓòÉΓòÉ 7. History Of Changes ΓòÉΓòÉΓòÉ
  442.  
  443. HTMLGen 1.10  A HTML Script Generator 
  444.  
  445.  History of changes. 
  446.  
  447.  1. Version 1.10 Aug. 15, 1995 
  448.  
  449.    o Added user-defined macro support. 
  450.  
  451.    o Added a backslash to the end of the special characters & . 
  452.  
  453.  2. Version 1.05 Jan. 31, 1995 
  454.  
  455.    o Corrected problem with data entry fields being too short or not usable. 
  456.  
  457.    o Improved help. 
  458.  
  459.    o Allowed both HTML script and IPF script screens to be re-sizable. 
  460.  
  461.  3. Version 1.04 Jan. 25, 1995 
  462.  
  463.    o Corrected problem with files, i.e. your browser, being corrupted 
  464.  
  465.    o Enlargened field lengths. 
  466.  
  467.    o Corrected problem with some tags. 
  468.  
  469.  4. Version 1.03 Jan. 21, 1995 
  470.  
  471.    o Integrated Browser/Editor programs. 
  472.  
  473.    o Added INI file. 
  474.  
  475.    o Improved IPF converter. 
  476.  
  477.  5. Version 1.02 Jan. 14, 1995 
  478.  
  479.    o First general release. 
  480.  
  481.  
  482. ΓòÉΓòÉΓòÉ 8. Author's Address and Information. ΓòÉΓòÉΓòÉ
  483.  
  484.  American Coders, LTD  joe@usacoder.rtp.nc.us (919) 846-2014 Copyright 1995 - 
  485. All rights reserverd